CSCF NPDB Client Configuration Mode Commands

CSCF NPDB Client Configuration Mode Commands
 
The NPDB Client Configuration Mode is used to set various commands supporting the role of the NPDB (Number Portability Data Base) client. The NPDB client in a CSCF service performs query for called subscriber number on NPDB server, which returns the Routing Number for the query.
note_smallImportant: The commands or keywords/variables that are available are dependent on platform type, product version, and installed license(s).
bind
Binds the NPDB client to an IP address.
Product
SCM (S-CSCF)
Privilege
Administrator
Syntax
bind address IPv4_address system-id system_id id client_id [ encrypted ] password password
no bind
address IPv4_address
Specifies the NPDB client IP address to establish the TCP connection with NPDB server.
IPv4_address must be expressed in dotted decimal notation for IPv4.
system-id system_id
Specifies the identifier of the system performing query to NPDB server.
system_id must be an unsigned integer from 0 to 4294962295.
id client_id
Specifies the ID of the NPDB client.
client_id must be from 1 to 15 alpha and/or numeric characters.
[ encrypted ] password password
Specifies the password of the NPDB client and whether it is encrypted.
password password must be from 1 to 15 alpha and/or numeric characters.
encrypted password password must be from 1 to 132 alpha and/or numeric characters.
note_smallImportant: Normally, encrypted passwords are only used inside configuration files
no bind
Removes the binding of the NPDB client.
Usage
Use this command to establish the NPDB client parameters for TCP connection with NPDB server.
note_smallImportant: This command can be entered multiple times to identify multiple IP addresses.
In connected state, only NPDB client will able to send query messages to get routing number from NPDB server. When query message is received in non-connected state from core, the NPDB client sends an error message to CSCF core.
Example
The following command binds the NPDB client to an IP address of 1.2.3.4, system ID of 4294, client ID of asdds, and encrypted password A01h4b5t5rojj205dhrete:
bind address 1.2.3.4 system-id 4294 id asdds encrypted password A01h4b5t5rojj205dhrete
end
Exits the current configuration mode and returns to the Exec mode.
Product
All
Privilege
Security Administrator, Administrator
Syntax
end
Usage
Use this command to return to the Exec mode.
exit
Exits the current mode and returns to the parent configuration mode.
Product
All
Privilege
Security Administrator, Administrator
Syntax
exit
Usage
Use this command to return to the parent configuration mode.
npdb-primary-server
Configure the NPDB primary server.
Product
SCM (S-CSCF)
Privilege
Administrator
Syntax
npdb-primary-server { address IPv4_address | domain domain } port port_number
no npdb-primary-server
address IPv4_address | domain domain
Specifies the NPDB primary server.
address IPv4_address: IP addresses must be expressed in dotted decimal notation for IPv4.
domain domain: Domain name must be entered using from 1 to 255 alpha and/or numeric characters.
port port_number
Specifies the port at which NPDB primary server listens.
port_number may be an integer from 1024 to 65534.
no
Removes the NPDB primary server.
Usage
Use this command to configure the NPDB primary server.
Example
The following command adds an NPDB primary server with an IP address of 1.2.3.4 and a port number of 3878:
npdb-primary-server address 1.2.3.4 port 3878
npdb-secondary-server
Configure the NPDB secondary server.
Product
SCM (S-CSCF)
Privilege
Administrator
Syntax
npdb-secondary-server { address IPv4_address | domain domain } port port_number
no npdb-secondary-server
address IPv4_address | domain domain
Specifies the NPDB secondary server.
address IPv4_address: IP addresses must be expressed in dotted decimal notation for IPv4.
domain domain: Domain name must be entered using from 1 to 255 alpha and/or numeric characters.
port port_number
Specifies the port at which NPDB secondary server listens.
port_number may be an integer from 1024 to 65534.
no
Removes the NPDB secondary server.
Usage
Use this command to configure the NPDB secondary server.
Example
The following command adds an NPDB secondary server with an IP address of 1.2.3.5 and a port number of 3878:
npdb-secondary-server address 1.2.3.5 port 3878
timeout
Sets timeout values for NPDB client.
Product
SCM (S-CSCF)
Privilege
Administrator
Syntax
timeout { bind-response sec | error-response sec | idle sec | ping sec | ping-response sec | query-response sec | release-response sec | tcp-retry sec }
[ default | no ] timeout { bind-response | error-response | idle | ping | ping-response | query-response | release-response | tcp-retry }
bind-response sec
Default: 30
This timer is used to specify the timeout for connection path creation in seconds.
sec must be an integer from 1 to 5000.
error-response sec
Default: 30
This timer is used to specify the timeout for error response in seconds.
sec must be an integer from 1 to 5000.
idle sec
Default: 30
This timer is used to specify the timeout interval for retrying failed NPDB BIND in seconds.
sec must be an integer from 1 to 5000.
ping sec
Default: 20
This timer is used to specify the timeout to send ping message to make the connection alive in seconds.
sec must be an integer from 1 to 5000.
ping-response sec
Default: 30
This timer is used to specify the timeout for ping response in seconds.
sec must be an integer from 1 to 5000.
query-response sec
Default: 6
This timer is used to specify the timeout for query response in seconds.
sec must be an integer from 1 to 5000.
release-response sec
Default: 30
This timer is used to specify the timeout for release response in seconds.
sec must be an integer from 1 to 5000.
tcp-retry sec
Default: 15
This timer is used to specify the timeout interval for retrying failed TCP connection in seconds.
sec must be an integer from 1 to 5000.
default
Returns the command to the default settings. See keywords above for specific defaults.
no
Deletes the value configured for the specified timer.
Usage
Use this command to configure timeout values for NPDB client.
When CSCF service is started, NPDB client establishes TCP connections with NPDB primary and secondary servers (if configured) and sets the connection path by sending Bind message to server. If NPDB client fails to establish TCP connection to either of the servers, it will retry the connection every TCPRetryTimer interval until it is successful. When the connection is successful, NPDB client will go to the connected state and will start PingTimer. Whenever NPDB client receives service request from CSCF core, it sends the request based on the connected state of the server(s); it should always give higher preference to the primary server. When it fails to send a query message to server, NPDB client returns failure to the core. If both servers are not in connected state, NPDB client will send failure message to CSCF core.
Example
The following command sets the release response timeout to 64 seconds:
timeout release-response 64
 
 
Cisco Systems Inc.
Tel: 408-526-4000
Fax: 408-527-0883